Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CobraDocs: Remove commit hash from docs. Fix issue with workdir replacement #17392

Merged
merged 7 commits into from
Dec 26, 2024
Merged

CobraDocs: Remove commit hash from docs. Fix issue with workdir replacement #17392

merged 7 commits into from
Dec 26, 2024
+14 −6

Conversation

rohit-nayak-ps
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps commented Dec 14, 2024 •
edited
Loading

Description

  • We remove the commit hash from the generated docs which resulted in unnecessary commits
  • There was a failure in the sed command to replace <WORKDIR> due to incorrect sed invocation. Fixed here.
  • There were files where the WORKDIR sed was not happening: fixed

Related Issue(s)

There is a related website PR vitessio/website#1904 which will enhance the current make target to generate the docs to add modified content files to git with an appropriate git message including the current vitess hash.

We need to first merge this PR into main and then run make generated-docs in the website PR before it is ready.

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@rohit-nayak-ps
Remove commit hash from docs. Fix issue with workdir replacement
c29b8de 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps rohit-nayak-ps added Type: Documentation Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Documentation docs related issues/PRs labels Dec 14, 2024
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 14, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Dec 14, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Dec 14, 2024
@rohit-nayak-ps
Attempt to replace WORKDIR for all files which are generated
11894f3 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps rohit-nayak-ps mentioned this pull request Dec 15, 2024
Draft
@rohit-nayak-ps
if file doesn't exist don't try to replace workdir
c42498d 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps rohit-nayak-ps removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Dec 15, 2024
@rohit-nayak-ps
Also ignore any Stat errors since dir may not have been created yet
6348cdd 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps
Ignore missing files for sed check
76e5f1f 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps
Ignore any errors for updating workdir for catch-all case
0314d7b 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps
Change test expectation which seems to fail only in CI
5b363ea 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@codecov Codecov
Copy link

codecov bot commented Dec 15, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 75.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 67.53%. Comparing base (44aa9d7) to head (5b363ea).
Report is 20 commits behind head on main.

Files with missing lines Patch % Lines
go/cmd/internal/docgen/docgen.go 75.00% 3 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #17392      +/-   ##
==========================================
+ Coverage   67.47%   67.53%   +0.05%     
==========================================
  Files        1581     1581              
  Lines      253944   253956      +12     
==========================================
+ Hits       171353   171503     +150     
+ Misses      82591    82453     -138

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review December 15, 2024 17:31
rohit-nayak-ps
rohit-nayak-ps commented Dec 26, 2024
View reviewed changes
go/cmd/internal/docgen/docgen.go

// We're replacing the stuff inside the square brackets in the example sed
// below:
// 's:Paths to search for config files in. (default \[.*\])$:Paths to search for config files in. (default \[<WORKDIR>\]):'
sed := exec.Command("sed", "-i", "-e", fmt.Sprintf("s:%s:<WORKDIR>:i", wd), file)
sed := exec.Command("sed", "-i", "", "-e", fmt.Sprintf("s:%s:%s:", wd, "<WORKDIR>"), file)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this has always been failing because the sed command was incorrect. Without this change the -e is seen as the value for -i and the sed fails.

@rohit-nayak-ps rohit-nayak-ps merged commit 837ddd4 into vitessio:main Dec 26, 2024
101 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the rohit/docgen-remove-commit-fix-workdir-replace branch December 26, 2024 11:38
rohit-nayak-ps added a commit to planetscale/vitess that referenced this pull request Dec 27, 2024
@rohit-nayak-ps
CobraDocs: Remove commit hash from docs. Fix issue with workdir repla…
ffa4f37 
…cement (vitessio#17392)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps rohit-nayak-ps mentioned this pull request Dec 27, 2024
Merged
5 tasks
rohit-nayak-ps added a commit to planetscale/vitess that referenced this pull request Dec 28, 2024
@rohit-nayak-ps
CobraDocs: Remove commit hash from docs. Fix issue with workdir repla…
5f96176 
…cement (vitessio#17392)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
rohit-nayak-ps added a commit that referenced this pull request Dec 30, 2024
@rohit-nayak-ps
[Direct PR] [V21 backport] CobraDocs: Remove commit hash from docs. F…
5c19f87 
…ix issue with workdir replacement (#17392) (#17444)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
vitess-bot pushed a commit that referenced this pull request Dec 30, 2024
@vitess-bot @vitess-bot
[Direct PR] [V21 backport] CobraDocs: Remove commit hash from docs. F…
c4ed66d 
…ix issue with workdir replacement (#17392) (#17444)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
dbussink pushed a commit that referenced this pull request Dec 30, 2024
@vitess-bot @dbussink
[Direct PR] [V21 backport] CobraDocs: Remove commit hash from docs. F…
013aefe 
…ix issue with workdir replacement (#17392) (#17444)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
dbussink pushed a commit that referenced this pull request Dec 30, 2024
@vitess-bot
[release-20.0] [Direct PR] [V21 backport] CobraDocs: Remove commit ha…
1aa5a1f 
…sh from docs. Fix issue with workdir replacement (#17392) (#17444) (#17451)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
rohit-nayak-ps added a commit that referenced this pull request Dec 30, 2024
@vitess-bot @rohit-nayak-ps
[release-19.0] [Direct PR] [V21 backport] CobraDocs: Remove commit ha…
1b615f5 
…sh from docs. Fix issue with workdir replacement (#17392) (#17444) (#17450)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Rohit Nayak <rohit@planetscale.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@mattlord mattlord mattlord approved these changes

@ajm188 ajm188 Awaiting requested review from ajm188 ajm188 is a code owner

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

Assignees
No one assigned
Labels
Component: Documentation docs related issues/PRs Type: Documentation Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@rohit-nayak-ps @mattlord @GuptaManan100